Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Author
|
Currently debugging Vercel's golang docs generation script. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I've moved the v1 docs to
docs-v1.renegade.fiand set updocs.renegade.fifor the v2 docs.Deployment details
https://docs-v1.renegade.fi points to the v1 docs.
https://docs-v2.renegade.fi points to the v2 docs.
We intend to configure Route53 such that https://docs.renegade.fi will also point to the v2 docs.
Vercel
The Build and Deployment -> Build Command in the Vercel project UI is set to
./scripts/build.sh. This script downloads the fonts, installs Golang and the right Python version, generates the SDK docs (via other scripts), and runsnpm run build.To deploy docs, run
vercel --prodindocs.renegade.fi. I haven't set up a Github workflow to automate this yet.Autogenerated SDK docs
scripts/download-fonts.shhelps with downloading the required fonts from our S3 bucket.generate-go-docs.sh,generate-python-docs.sh,generate-rust-docs.sh, andgenerate-ts-docs.shwill generate static SDK docs, which should not be checked in to the repo.Algolia
I've set up a new index for both the v1 and v2 docs, and configured the crawlers accordingly.
v1 index:
renegade-docs-v1, linked to therenegade-docs-v1crawlerv2 index:
renegade-docs-v2, linked to therenegade-docs-v2crawlerWe can delete the
renegadeandrenegade-prodindices now that they aren't in use.